/*
 * Copyright 2012 myTDev.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mytdev.beans;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The EventHandler annotation allow to mark target object fields. It is used by
 * the {@link EventHandlerInjector} to create and inject listners using
 * {@link java.beans.EventHandler}.
 *
 * @author Yann D'Isanto
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EventHandler {

	/**
	 * The name of a (possibly qualified) property or method on the target.
	 *
	 * @see "action" in {@link java.beans.EventHandler}.
	 */
	String value();

	/**
	 * The (possibly qualified) name of a readable property of the incoming
	 * event.
	 */
	String eventProperty() default "";

	/**
	 * The name of the method in the listener interface that should trigger the
	 * action.
	 */
	String listenerMethod() default "";

}
